Resource URL: /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

    Overview: This resource exposes a single OneFS network subnet.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: View a network subnet.

       URL: GET
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

Query arguments:
force=<boolean> force modifying this subnet even if it causes an MTU conflict.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "subnets": {
      "items": {
        "type": "object", 
        "properties": {
          "prefixlen": {
            "minimum": 1, 
            "type": "integer", 
            "description": "Subnet Prefix Length.", 
            "maximum": 128
          }, 
          "mtu": {
            "minimum": 576, 
            "type": "integer", 
            "description": "MTU of the subnet.", 
            "maximum": 9000
          }, 
          "description": {
            "type": "string", 
            "description": "A description of the subnet.", 
            "maxLength": 128
          }, 
          "base_addr": {
            "type": "string", 
            "description": "The base IP address."
          }, 
          "gateway_priority": {
            "minimum": 1, 
            "type": "integer", 
            "description": "Gateway priority.", 
            "maximum": 2147483647
          }, 
          "vlan_enabled": {
            "type": "boolean", 
            "description": "VLAN tagging enabled or disabled."
          }, 
          "dsr_addrs": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "List of Direct Server Return addresses."
          }, 
          "pools": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Name of the pools in the subnet."
          }, 
          "sc_service_addr": {
            "type": "string", 
            "description": "The address that SmartConnect listens for DNS requests."
          }, 
          "id": {
            "type": "string", 
            "description": "Unique Subnet ID."
          }, 
          "groupnet": {
            "type": "string", 
            "description": "Name of the groupnet this subnet belongs to."
          }, 
          "addr_family": {
            "enum": [
              "ipv4", 
              "ipv6"
            ], 
            "type": "string", 
            "description": "IP address format."
          }, 
          "gateway": {
            "type": "string", 
            "description": "Gateway IP address."
          }, 
          "vlan_id": {
            "minimum": 2, 
            "type": "integer", 
            "description": "VLAN ID for all interfaces in the subnet.", 
            "maximum": 4094
          }, 
          "name": {
            "type": "string", 
            "description": "The name of the subnet.", 
            "maxLength": 32
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify a network subnet.

       URL: PUT
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "description": {
      "type": "string", 
      "description": "A description of the subnet.", 
      "maxLength": 128
    }, 
    "gateway_priority": {
      "minimum": 1, 
      "type": "integer", 
      "description": "Gateway priority.", 
      "maximum": 2147483647
    }, 
    "vlan_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "VLAN tagging enabled or disabled."
        }
      ]
    }, 
    "mtu": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 576, 
          "type": "integer", 
          "description": "MTU of the subnet.", 
          "maximum": 9000
        }
      ]
    }, 
    "sc_service_addr": {
      "type": "string", 
      "description": "The address that SmartConnect listens for DNS requests."
    }, 
    "prefixlen": {
      "minimum": 1, 
      "type": "integer", 
      "description": "Subnet Prefix Length.", 
      "maximum": 128
    }, 
    "dsr_addrs": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of Direct Server Return addresses."
    }, 
    "gateway": {
      "type": "string", 
      "description": "Gateway IP address."
    }, 
    "vlan_id": {
      "minimum": 2, 
      "type": "integer", 
      "description": "VLAN ID for all interfaces in the subnet.", 
      "maximum": 4094
    }, 
    "name": {
      "type": "string", 
      "description": "The name of the subnet.", 
      "maxLength": 32
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete a network subnet..

          URL: DELETE
               /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>

Query arguments:
force=<boolean> force deleting this subnet even if pools in other subnets rely
                on this subnet's SC VIP.

There is no response body for this method.
